package com.fafi.selfmvc.interceptors;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LoginInterceptor implements HandlerInterceptor {

	static Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);

	/**
	 * 这个方法在业务处理器处理请求之前被调用，SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，
	 * 所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，
	 * 也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。
	 * 该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，
	 * 后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，
	 * 如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。
	 * @param request current HTTP request
	 * @param response current HTTP response
	 * @param handler chosen handler to execute, for type and/or instance evaluation
	 * @return
	 * @throws Exception
	 */
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		logger.debug("preHandle");
		System.out.println("LoginInterceptor:preHandle");
		return true; //true 表示继续执行，false 为停止执行并返回。
	}

	/**
	 * 这个方法在当前请求进行处理之后，也就是Controller 方法调用之后执行，
	 * 但是它会在DispatcherServlet 进行视图返回渲染之前被调用，
	 * 所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。
	 * postHandle 方法被调用的方向跟preHandle 是相反的，
	 * 也就是说先声明的Interceptor 的postHandle 方法反而会后执行。
	 * @param request current HTTP request
	 * @param response current HTTP response
	 * @param handler the handler (or {@link }) that started asynchronous
	 * execution, for type and/or instance examination
	 * @param modelAndView the {@code ModelAndView} that the handler returned
	 * (can also be {@code null})
	 * @throws Exception
	 */
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		logger.debug("postHandle");
		System.out.println("LoginInterceptor:postHandle");
		System.out.println(modelAndView);
	}

	/**
	 * 该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。
	 * 这个方法的主要作用是用于进行资源清理工作的。
	 * @param request current HTTP request
	 * @param response current HTTP response
	 * @param handler the handler (or {@link }) that started asynchronous
	 * execution, for type and/or instance examination
	 * @param ex any exception thrown on handler execution, if any; this does not
	 * include exceptions that have been handled through an exception resolver
	 * @throws Exception
	 */
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		logger.debug("afterCompletion");
		System.out.println("LoginInterceptor:afterCompletion");
	}
}
